一般的なオプション¶

-C file, --config-file=file

デフォルトの ~/.manpath ではなく指定したユーザ設定ファイルを使用します。

-d, --debug

デバッグ情報を表示します。

-D, --default

通常はこのオプションを一番最初に指定し、 man の動作をデフォルトにリセットします。これを使用すると、 $MANOPT で設定されているオプションをリセットできます。 -D の後に続くオプションは通常通りの効果があります。

--warnings[=warnings]

groff からの警告を有効にします。このオプションはマニュアルページのソーステキストの整合性検査を行うために使用されます。 warnings はコンマ区切りの警告名のリストです。指定されていない場合はデフォルト値として "mac" が使用されます。使用可能な警告名に関しては info groff の “Warnings” ノードを参照してください。

操作のメインモード¶

-f, --whatis

Equivalent to whatis. Display a short description from the manual page, if available. See whatis(1) for details.

-k, --apropos

apropos と同様です。キーワード (keywords) に一致するマニュアルページの短い要約文を検索し、それを表示します。詳細は apropos(1) を参照してください。

-K, --global-apropos

すべてのマニュアルページのテキストを検索します。全数検索を行うため、長い時間がかかります。検索するページ数を減らすために、可能であればセクションを指定するべきです。検索する語はデフォルトでは単純な文字列です。 --regex オプションを指定した場合は正規表現になります。

Note that this searches the sources of the manual pages, not the rendered text, and so may include false positives due to things like comments in source files. Searching the rendered text would be much slower.

-l, --local-file

Activate "local" mode. Format and display local manual files instead of searching through the system's manual collection. Each manual page argument will be interpreted as an nroff source file in the correct format. No cat file is produced. If '-' is listed as one of the arguments, input will be taken from stdin. When this option is not used, and man fails to find the page required, before displaying the error message, it attempts to act as if this option was supplied, using the name as a filename and looking for an exact match.

-w, --where, --path, --location

Don't actually display the manual page, but do print the location of the source nroff file that would be formatted. If the -a option is also used, then print the locations of all source files that match the search criteria.

-W, --where-cat, --location-cat

Don't actually display the manual page, but do print the location of the preformatted cat file that would be displayed. If the -a option is also used, then print the locations of all preformatted cat files that match the search criteria.

If -w and -W are both used, then print both source file and cat file separated by a space. If all of -w, -W, and -a are used, then do this for each possible match.

-c, --catman

このオプションは一般的には使用しません。 catman プログラムのみが使用します。

-R encoding, --recode=encoding

マニュアルページを通常の方法で整形する代わりに、 encoding で指定したエンコーディングに変換して出力します。ソースファイルのエンコーディングを知っている場合は、 manconv(1) を直接使用することもできます。しかしながら、このオプションにより、マニュアルページ階層と同様の構造でインストールされた形で提供されている、複数のマニュアルページのエンコーディングを明示的に意識することなく単一のエンコーディングに変換して出力できます。

Consider using man-recode(1) instead for converting multiple manual pages, since it has an interface designed for bulk conversion and so can be much faster.

マニュアルページの検索方法¶

-L locale, --locale=locale

man は通常、現在のロケールを C の関数 setlocale(3) を呼び出すことによって決定します。これはおそらく $LC_MESSAGES や $LANG などを含むさまざまな環境変数を使用します。一時的にこの値を上書きしたい場合には、このオプションを使用して man に直接 locale 文字列を渡します。これはページの検索が実際に開始されるまでは効果が無いことに注意してください。ヘルプメッセージなどは常に初期に決定されたロケールによって表示されます。

-m system[,...], --systems=system[,...]

システム上で他のシステムのマニュアルページにアクセス可能な場合、このオプションを指定してアクセスします。 NewOS のマニュアルページを参照する場合はオプション -m NewOS を使用します。

system はコンマ区切りのオペレーティングシステム名で指定します。現在使用しているオペレーティングシステムのマニュアルページを含める場合には、システム名の引数に man を含めます。このオプションは $SYSTEM 環境変数を上書きします。

-M path, --manpath=path

代替のマニュアルページ検索パスを指定します。デフォルトでは man は manpath で取得できるコードを使用してから検索するパスを決定します。このオプションは $MANPATH 環境変数を上書きし、 -m オプションは無視されます。

A path specified as a manpath must be the root of a manual page hierarchy structured into sections as described in the man-db manual (under "The manual page system"). To view manual pages outside such hierarchies, see the -l option.

-S list, -s list, --sections=list

The given list is a colon- or comma-separated list of sections, used to determine which manual sections to search and in what order. This option overrides the $MANSECT environment variable. (The -s spelling is for compatibility with System V.)

-e sub-extension, --extension=sub-extension

Some systems incorporate large packages of manual pages, such as those that accompany the Tcl package, into the main manual page hierarchy. To get around the problem of having two manual pages with the same name such as exit(3), the Tcl pages were usually all assigned to section l. As this is unfortunate, it is now possible to put the pages in the correct section, and to assign a specific "extension" to them, in this case, exit(3tcl). Under normal operation, man will display exit(3) in preference to exit(3tcl). To negotiate this situation and to avoid having to know which section the page you require resides in, it is now possible to give man a sub-extension string indicating which package the page must belong to. Using the above example, supplying the option -e tcl to man will restrict the search to pages having an extension of *tcl.

-i, --ignore-case

マニュアルページを検索する時に大文字と小文字の区別をしません。これはデフォルトの動作です。

-I, --match-case

マニュアルページを検索する時に大文字と小文字を区別します。

--regex

Show all pages with any part of either their names or their descriptions matching each page argument as a regular expression, as with apropos(1). Since there is usually no reasonable way to pick a "best" page when searching for a regular expression, this option implies -a.

--wildcard

Show all pages with any part of either their names or their descriptions matching each page argument using shell-style wildcards, as with apropos(1) --wildcard. The page argument must match the entire name or description, or match on word boundaries in the description. Since there is usually no reasonable way to pick a "best" page when searching for a wildcard, this option implies -a.

--names-only

--regex または --wildcard オプションと併せて使用した場合、一致処理を要約文に対して行わず、ページ名のみに一致処理を行います。 whatis(1) で使用した時も同様です。その他の場合は何も効果を及ぼしません。

-a, --all

デフォルトでは、 man は最適なマニュアルページを表示した後に終了します。このオプションを使用すると、検索条件に一致したすべてのマニュアルページを順番に表示します。

-u, --update

This option causes man to update its database caches of installed manual pages. This is only needed in rare situations, and it is normally better to run mandb(8) instead.

--no-subpages

By default, man will try to interpret pairs of manual page names given on the command line as equivalent to a single manual page name containing a hyphen or an underscore. This supports the common pattern of programs that implement a number of subcommands, allowing them to provide manual pages for each that can be accessed using similar syntax as would be used to invoke the subcommands themselves. For example:

  $ man -aw git diff
  /usr/share/man/man1/git-diff.1.gz

To disable this behaviour, use the --no-subpages option.

  $ man -aw --no-subpages git diff
  /usr/share/man/man1/git.1.gz
  /usr/share/man/man3/Git.3pm.gz
  /usr/share/man/man1/diff.1.gz

整形済み出力の制御¶

-P pager, --pager=pager

Specify which output pager to use. By default, man uses less, falling back to cat if less is not found or is not executable. This option overrides the $MANPAGER environment variable, which in turn overrides the $PAGER environment variable. It is not used in conjunction with -f or -k.

この値は、単純なコマンド名か引数付きのコマンドで、シェルのエスケープ文字 (バックスラッシュ、シングルクォート、ダブルクォート) を使用している場合があります。パイプを使用して複数のコマンドをつなげることはできません。そのような必要性がある場合、表示するファイルを、単一の引数または標準入力として受け取るラッパースクリプトを使用します。

-r prompt, --prompt=prompt

less の最近のバージョンをページャーと指定使用している場合、 man はプロンプトに有意義な情報を表示するための設定をします。デフォルトのプロンプトは次の通りです。

Manual page name(sec) line x

name はマニュアルページの名前です。 sec はマニュアルページが見つかったセクション名です。そして x は現在の行番号です。これは $LESS 環境変数を使用して行われています。

Supplying -r with a string will override this default. The string may contain the text $MAN_PN which will be expanded to the name of the current manual page and its section name surrounded by "(" and ")". The string used to produce the default could be expressed as

\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(press h for help or q to quit)

ここでは読みやすさを考慮して3行に分割しています。実際の意味については less(1) のマニュアルページを参照してください。プロンプトの文字列は最初にシェルによって解釈されます。プロンプト内のすべてのダブルクォート、バッククォート、およびバックスラッシュは前にバックスラッシュを配置してエスケープしなければいけません。プロンプト文字列はエスケープされた $ で終了し、その後に less 用のオプションが続いている場合があります。デフォルトでは、 man は -ix8 オプションを設定します。

The $MANLESS environment variable described below may be used to set a default prompt string if none is supplied on the command line.

-7, --ascii

純粋な ascii(7) マニュアルページを、 7 ビット端末または端末エミュレーターで参照する場合、 latin1(7) デバイス設定と GNU nroff を併せて使用した時に、いくつかの文字は正しく表示されません。このオプションを使用すると、純粋な ascii マニュアルページを表示時に latin1 デバイス設定を使用して ascii で表示することができます。これは latin1 テキストは全く変換しません。次の表は実行される変換を表します。これらのうちのいくつかは GNU nroff の latin1(7) デバイス設定を使用した場合にのみ正しく表示されます。

説明	八進数	latin1	ascii
continuation hyphen	255	‐	-
bullet (中点)	267	•	o
acute アクセント	264	´	'
乗算記号	327	×	x

latin1 列が正しく表示される場合は、端末は latin1 文字を扱えるように設定されているためこのオプションは不要です。 latin1 列と ascii 列が同一の場合、このオプションを使用してこのページを見ているか、 man が latin1 デバイス設定を使用していません。 latin1 列が欠けているか表示がおかしい場合、マニュアルページを参照する時にこのオプションを使用する必要があります。

-t、 -H、 -T、 または -Z オプションを使用している場合、および GNU groff 以外を使用している場合は意味がありません。

-E encoding, --encoding=encoding

デフォルト以外の文字エンコーディングで出力を生成します。過去の互換性のために、 encoding には、UTF-8 のような実際のエンコーディングに加えて ascii、 latin1、または utf8 のような nroff デバイス設定も使用できます。

--no-hyphenation, --nh

通常、 nroff は、単語内にハイフンが無かったとしても、改行部分でテキストに自動的にハイフンを付加します。これにより、行内の単語間に過剰なスペースが配置されることを防ぎます。このオプションは自動的なハイフン付加を無効にします。よって、ハイフンが含まれている単語のみハイフン区切りが行われます。

マニュアルページを書いていて、 nroff が単語内の誤った場所にハイフンを付加するのを防止したい場合、このオプションを使用しないでください。代わりに nroff の文書を参照してください。例えば、 "\%" を単語内に含めると、その場所にハイフンを付加することが可能であることを示します。また、 "\%" を単語の最初に付加すると、その単語にはハイフンは付加されません。

--no-justification, --nj

通常、 nroff は自動的に左右余白に対してテキストを均等割り付けします。このオプションは左右余白の均等割り付けを抑止し、左側余白のみ整列します。これは "ragged-right" text と呼ばれます。

マニュアルページを書いていて、 nroff がある段落に対して均等割り付けを行うのを防止したい場合、このオプションを使用しないでください。代わりに nroff の文書を参照してください。例えば ".na" 、 ".nf" 、 ".fi" 、 および ".ad" を使用すると一時的に字間調整や字詰めを無効にするように要求できます。

-p string, --preprocessor=string

nroff または troff/groff の前に実行する前処理系の順序を指定します。必ずしもすべてのインストールされたシステムで完全な前処理系集合が使用できるわけではありません。いくつかの前処理系とそれを使用して整形する文字の例は eqn (e)、 grap (g)、 pic (p)、 tbl (t)、 vgrind (v)、 refer (r) です。このオプションは $MANROFFSEQ 環境変数を上書きします。 zsoelim は常に最初の前処理系として使用されます。

-t, --troff

groff -mandoc を使用してマニュアルページを整形し、標準出力へ出力します。このオプションは -H、 -T、または -Z オプションと併せて使用する必要はありません。

-T[device], --troff-device[=device]

このオプションは groff (または troff) の出力をデフォルト以外の適切なデバイス設定に変更するために使用します。暗黙的に -t が指定されます。 例は (groff-1.17 を使用した時) dvi、 latin1、 ps、 utf8、 X75 および X100 です。

-H[browser], --html[=browser]

このオプションを指定した場合、 groff は HTML 出力を生成し、その出力をウェブブラウザーで表示します。ブラウザーはオプション引数の browser (指定されている場合)、 $BROWSER 環境変数が使用されます。それらが設定されていない場合はコンパイル時のデフォルト (通常は lynx) が使用されます。このオプションにより暗黙的に -t が指定されます。そして、 GNU troff を使用している時のみ有効です。

-X[dpi], --gxditview[=dpi]

このオプションを指定した場合、 gxditview プログラムを使用して、groff の出力をグラフィカルウィンドウに表示します。 dpi (ドット/インチ) は 75、 75-12、 100、 または 100-12 であり、デフォルトは 75 です。 -12 では 12 ポイントのフォントを使用します。このオプションにより -T オプションと、その引数としてそれぞれ X75、 X75-12、 X100、または X100-12 デバイス設定が暗黙的に指定されます。

-Z, --ditroff

groff は troff を実行した後、適切な後処理系を使用して、選択したデバイス設定に適した出力を生成します。 groff -mandoc が groff の場合、このオプションは groff に渡され、後処理系の使用が抑止されます。このオプションにより -t が暗黙的に指定されます。

ヘルプの取得¶

-?, --help

ヘルプメッセージを表示して終了します。

--usage

Print a short usage message and exit.

-V, --version

バージョン情報を表示します。